PinningApi

All URIs are relative to //api.estuary.tech/

Method	HTTP request	Description
pinningPinsGet	GET /pinning/pins	List all pin status objects
pinningPinsPinidDelete	DELETE /pinning/pins/{pinid}	Delete a pinned object
pinningPinsPinidGet	GET /pinning/pins/{pinid}	Get a pin status object
pinningPinsPinidPost	POST /pinning/pins/{pinid}	Replace a pinned object
pinningPinsPost	POST /pinning/pins	Add and pin object

pinningPinsGet

TypesIpfsListPinStatusResponse pinningPinsGet()

List all pin status objects

This endpoint lists all pin status objects

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PinningApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

PinningApi apiInstance = new PinningApi();
try {
    TypesIpfsListPinStatusResponse result = apiInstance.pinningPinsGet();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PinningApi#pinningPinsGet");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

TypesIpfsListPinStatusResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

pinningPinsPinidDelete

pinningPinsPinidDelete(pinid)

Delete a pinned object

This endpoint deletes a pinned object.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PinningApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

PinningApi apiInstance = new PinningApi();
String pinid = "pinid_example"; // String | Pin ID
try {
    apiInstance.pinningPinsPinidDelete(pinid);
} catch (ApiException e) {
    System.err.println("Exception when calling PinningApi#pinningPinsPinidDelete");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
pinid	String	Pin ID

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

pinningPinsPinidGet

TypesIpfsPinStatusResponse pinningPinsPinidGet(pinid)

Get a pin status object

This endpoint returns a pin status object.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PinningApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

PinningApi apiInstance = new PinningApi();
String pinid = "pinid_example"; // String | cid
try {
    TypesIpfsPinStatusResponse result = apiInstance.pinningPinsPinidGet(pinid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PinningApi#pinningPinsPinidGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
pinid	String	cid

Return type

TypesIpfsPinStatusResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

pinningPinsPinidPost

TypesIpfsPinStatusResponse pinningPinsPinidPost(body, pinid)

Replace a pinned object

This endpoint replaces a pinned object.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PinningApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

PinningApi apiInstance = new PinningApi();
TypesIpfsPin body = new TypesIpfsPin(); // TypesIpfsPin | New pin
String pinid = "pinid_example"; // String | Pin ID to be replaced
try {
    TypesIpfsPinStatusResponse result = apiInstance.pinningPinsPinidPost(body, pinid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PinningApi#pinningPinsPinidPost");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	TypesIpfsPin	New pin
pinid	String	Pin ID to be replaced

Return type

TypesIpfsPinStatusResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

pinningPinsPost

TypesIpfsPinStatusResponse pinningPinsPost(body, ignoreDupes, overwrite)

Add and pin object

This endpoint adds a pin to the IPFS daemon.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PinningApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

PinningApi apiInstance = new PinningApi();
TypesIpfsPin body = new TypesIpfsPin(); // TypesIpfsPin | Pin Body {cid:cid, name:name}
String ignoreDupes = "ignoreDupes_example"; // String | Ignore Dupes
String overwrite = "overwrite_example"; // String | Overwrite conflicting files in collections
try {
    TypesIpfsPinStatusResponse result = apiInstance.pinningPinsPost(body, ignoreDupes, overwrite);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PinningApi#pinningPinsPost");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	TypesIpfsPin	Pin Body {cid:cid, name:name}
ignoreDupes	String	Ignore Dupes	[optional]
overwrite	String	Overwrite conflicting files in collections	[optional]

Return type

TypesIpfsPinStatusResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json